Skip to main content

Create Destination

Route

/v2/streaming/destinations

Description

Create a new streaming destination for real-time data export. Destinations are HTTPS endpoints that receive streamed data from Cyberhaven.

Method

POST

Inputs

ParameterTypeRequiredDescription
namestringYesDestination name (max 100 characters)
descriptionstringNoDestination description (max 500 characters)
typestringYesDestination type (must be "https")
formatstringYesData format (json, json_lines)
encodingstringNoEncoding type (none, gzip) - defaults to none
https_configobjectYesHTTPS configuration object

HTTPS Config Object

FieldTypeRequiredDescription
uristringYesHTTPS endpoint URL
headersobjectNoCustom HTTP headers
timeout_secondsintegerNoRequest timeout (1-300 seconds, default 30)

Request Example

{
"name": "SIEM Integration",
"description": "Stream to Splunk SIEM",
"type": "https",
"format": "json_lines",
"encoding": "gzip",
"https_config": {
"uri": "https://splunk.company.com/services/collector/event",
"headers": {
"Authorization": "Splunk your-token-here"
},
"timeout_seconds": 60
}
}

Output

FieldTypeDescription
idstringUnique destination identifier
namestringDestination name
descriptionstringDestination description
typestringDestination type
formatstringData format
encodingstringEncoding type
https_configobjectHTTPS configuration details
created_atstringCreation timestamp (ISO 8601)
updated_atstringLast update timestamp (ISO 8601)

Rate Limit

  • 60 requests per minute per API key
  • 5 concurrent requests per endpoint

Example Response

{
"id": "dest-456",
"name": "SIEM Integration",
"description": "Stream to Splunk SIEM",
"type": "https",
"format": "json_lines",
"encoding": "gzip",
"https_config": {
"uri": "https://splunk.company.com/services/collector/event",
"timeout_seconds": 60
},
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:30:00Z"
}